Skip to content

[chore] Update the README #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
sfc-gh-bnisco merged 1 commit into from
Oct 31, 2025
Merged

[chore] Update the README #115

sfc-gh-bnisco merged 1 commit into from
Oct 31, 2025

Conversation

@sfc-gh-bnisco
Copy link
Contributor

@sfc-gh-bnisco sfc-gh-bnisco commented Oct 28, 2025 •
edited
Loading

TL;DR

Updated the README with v2 component API documentation and improved development instructions.

What changed?

  • Restructured the main README to prominently feature both v1 and v2 component APIs
  • Added code samples for both APIs with expandable sections
  • Updated the quickstart section to use Cookiecutter and uv for generating new components
  • Added information about pre-generated templates for easy browsing
  • Added development install instructions with -e flag to all template READMEs

This was referenced Oct 28, 2025
Merged
Merged
Merged
Merged
Merged
Merged
@sfc-gh-bnisco
Copy link
Contributor Author

sfc-gh-bnisco commented Oct 28, 2025 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch 2 times, most recently from 6099f59 to cb7320f Compare October 29, 2025 03:17
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch 2 times, most recently from 2e5927b to 708f243 Compare October 29, 2025 03:26
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from cb7320f to cadc680 Compare October 29, 2025 03:26
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from 708f243 to 25660ad Compare October 29, 2025 03:28
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from cadc680 to 7915069 Compare October 29, 2025 03:28
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from 25660ad to 5822e3f Compare October 29, 2025 03:38
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from 7915069 to 0118831 Compare October 29, 2025 03:38
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from 5822e3f to eab014f Compare October 29, 2025 16:56
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from 0118831 to fe56ddc Compare October 29, 2025 16:56
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from eab014f to 9ab94ae Compare October 31, 2025 18:01
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch 3 times, most recently from 69b6d34 to e2a1bf4 Compare October 31, 2025 18:26
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from 9ab94ae to 5217cad Compare October 31, 2025 18:26
@sfc-gh-bnisco sfc-gh-bnisco marked this pull request as ready for review October 31, 2025 18:27
@sfc-gh-bnisco sfc-gh-bnisco requested review from a team as code owners October 31, 2025 18:27
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from 5217cad to 866a7ba Compare October 31, 2025 18:35
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from e2a1bf4 to 1d21554 Compare October 31, 2025 18:35
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-add-cookiecutter-reactless branch from 866a7ba to cc3c692 Compare October 31, 2025 18:43
@sfc-gh-bnisco sfc-gh-bnisco changed the base branch from v2-support-add-cookiecutter-reactless to graphite-base/115 October 31, 2025 18:44
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from 1d21554 to 4ad59b7 Compare October 31, 2025 18:44
@sfc-gh-bnisco sfc-gh-bnisco changed the base branch from graphite-base/115 to master October 31, 2025 18:44
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from 4ad59b7 to 525e700 Compare October 31, 2025 18:45
@sfc-gh-bnisco sfc-gh-bnisco force-pushed the v2-support-update-readme branch from 525e700 to 1868656 Compare October 31, 2025 18:55
@sfc-gh-bnisco sfc-gh-bnisco merged commit b778e18 into master Oct 31, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kmcgrady kmcgrady kmcgrady approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sfc-gh-bnisco @kmcgrady